-- *****************************************************************
-- CISCO-OPTICAL-PATCH-MIB.my: Cisco optical patch MIB file
--
-- March 2002, Suresh Basavarajappa, Mickey Spiegel and Sameer Merchant
--
-- Copyright (c) 2001, 2002 by cisco Systems, Inc.
-- All rights reserved.
--
-- *****************************************************************CISCO-OPTICAL-PATCH-MIB DEFINITIONS::=BEGINIMPORTSMODULE-IDENTITY,OBJECT-TYPE,Integer32,NOTIFICATION-TYPEFROM SNMPv2-SMI
RowStatus,TimeStamp,TruthValueFROM SNMPv2-TC
NOTIFICATION-GROUP,MODULE-COMPLIANCE,OBJECT-GROUPFROM SNMPv2-CONF
ciscoExperiment FROM CISCO-SMI
InterfaceIndex, ifIndex FROM IF-MIB;ciscoOpticalPatchMIB MODULE-IDENTITYLAST-UPDATED"200203180000Z"-- 03/18/2002ORGANIZATION"Cisco Systems, Inc."CONTACT-INFO"Cisco Systems
Customer Service
Postal: 170 W Tasman Drive
San Jose, CA 95134
Tel: +1 800 553-NETS
E-mail: cs-dwdm@cisco.com"DESCRIPTION"This MIB module is used to configure and monitor the network
element view of optical patches between two ports or
fibers on the same network element.
It is up to the user to keep the provisioned information that
is reflected in this MIB module in sync with the actual patches
present between ports or fibers on the network element.
Provisioning of a patch does not cause a patch to be inserted;
it only informs the network element that a patch has been, or
is soon to be, added or removed."REVISION"200203180000Z"-- 03/18/2002DESCRIPTION"This revision adds support for patching one interface to two
different interfaces in the receive and transmit directions.
This revision deprecates the cOPatchInterfaceTable and
replaces it with the new cOPatchIntfTable. This new table
includes the cOPatchIntfDirection object along with ifIndex
as part of the table index. The cOPatchIntfDirection object
identifies whether this interface is patched to another
interface within a network element in the receive, transmit
or both directions.
A new object cOPatchDirOnLowIf is added to the cOPatchTable
in order to identify the patch direction relative to the
interface with low ifIndex."REVISION"200109050000Z"DESCRIPTION"Initial version of this MIB module."::={ ciscoExperiment 67}cOPatchMIBObjects OBJECTIDENTIFIER::={ ciscoOpticalPatchMIB 1}
-- MIB Object Definitions-- Patch Interface GroupcOPatchInterfaceTable OBJECT-TYPESYNTAXSEQUENCEOF COPatchInterfaceEntry
MAX-ACCESSnot-accessibleSTATUSdeprecatedDESCRIPTION"This table lists all interfaces that are provisioned to
indicate that they are patched to other interfaces on the same
network element. The table is used to find patches that
include a particular interface.
This table is deprecated since it only includes bidirectional
patches. The new cOPatchIntfTable includes both unidirectional
patches (in the transmit or receive direction) and
bidirectional patches."::={ cOPatchMIBObjects 1}cOPatchInterfaceEntry OBJECT-TYPESYNTAX COPatchInterfaceEntry
MAX-ACCESSnot-accessibleSTATUSdeprecatedDESCRIPTION"An entry is created only when an interface is provisioned
to indicate that it is patched to another interface on the same
network element (i.e. when the associated entry in the
cOPatchTable has been created).
An entry is deleted when the interface is removed from a patch,
or when the patch is deleted from the cOPatchTable."INDEX{ ifIndex }
::={ cOPatchInterfaceTable 1}
COPatchInterfaceEntry ::=SEQUENCE{
cOPatchIdentifier Integer32}cOPatchIdentifier OBJECT-TYPESYNTAXInteger32(1..2147483547)MAX-ACCESSread-onlySTATUSdeprecatedDESCRIPTION"The value of cOPatchIndex used in the cOPatchTable to identify
a patch that includes this interface. The other interface
included in that patch has an entry in this table with the same
value of this object, in addition to the entry in the
cOPatchTable with this value of cOPatchIndex."::={ cOPatchInterfaceEntry 1}-- Patch GroupcOPatchIndexNext OBJECT-TYPESYNTAXInteger32(0..2147483647)MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"This object contains an appropriate value to be used for
cOPatchIndex when creating entries in the cOPatchTable. The
value 0 indicates that no unassigned entries are available.
To obtain the cOPatchIndex value for a new entry, the manager
issues a management protocol retrieval operation to obtain the
current value of this object.
The agent will modify the value to the next unassigned index,
when a new row is created in cOPatchTable with the current
value of this object. After deletion of a row in cOPatchTable
the agent will determine through its local policy when its
index value will be made available for reuse."::={ cOPatchMIBObjects 2}cOPatchLastChange OBJECT-TYPESYNTAXTimeStampMAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The value of sysUpTime at the time of the last
creation, deletion or modification of an entry
in the cOPatchTable. If the cOPatchTable entries has been
unchanged since the last re-initialization of the local
network management subsystem, then this object contains a
zero value."::={ cOPatchMIBObjects 3}cOPatchEventType OBJECT-TYPESYNTAXINTEGER{create(1),delete(2),modify(3)}-- MAX-ACCESS accessible-for-notifyMAX-ACCESSread-onlySTATUScurrent
DESCRIPTION"The event type of the patch. The use is as follows:
create(1)
The value of this object when cOPatchEvent is generated
upon creation of a patch.
delete(2)
The value of this object when cOPatchEvent is generated
upon deletion of a patch.
modify(3)
The value of this object when cOPatchEvent is generated
upon modification of a patch."::={ cOPatchMIBObjects 4}cOPatchTable OBJECT-TYPESYNTAXSEQUENCEOF COPatchEntry
MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"This table contains the network element view of optical patches
between two interfaces on the same network element.
It is up to the user to keep the provisioned information that
is reflected in this table in sync with the actual patches
present between interfaces on the network element.
Provisioning of a patch in this table does not cause a patch to
be inserted; it only informs the network element that a patch
has been, or is soon to be, added or removed.
Each entry in the table models a unidirectional or
bidirectional patch between two interfaces on the same
network element. When one interface is patched to two
different interfaces, one in the receive direction and
the other in the transmit direction, the interface will
appear in two different entries in the table.
The terms low and high are chosen to represent numerical
ordering of the two interfaces associated with a patch. That
is, the interface with the lower value of ifIndex is termed
'low', while the other interface associated with the patch is
termed 'high'."::={ cOPatchMIBObjects 5}cOPatchEntry OBJECT-TYPESYNTAX COPatchEntry
MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"This entry is used to model a unidirectional or
bidirectional patch between two interfaces on the same
network element.
An entry is created when the network element is provisioned to
indicate that two interfaces on the network element have been
patched together using an optical patch cord.
Prior to creating an entry in the table, the manager should
obtain a unique value of cOPatchIndex by reading the
cOPatchIndexNext object. When an entry in the table is
created, the cOPatchIntfPatchId values in the corresponding
cOPatchIntfTable rows are filled in by the agent."INDEX{ cOPatchIndex }::={ cOPatchTable 1}
COPatchEntry ::=SEQUENCE{
cOPatchIndex Integer32,
cOPatchLowIfIndex InterfaceIndex,
cOPatchHighIfIndex InterfaceIndex,
cOPatchType INTEGER,
cOPatchStatus INTEGER,
cOPatchCreationTime TimeStamp,
cOPatchRowStatus RowStatus,
cOPatchDirOnLowIf INTEGER}cOPatchIndex OBJECT-TYPESYNTAXInteger32(1..2147483647)MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"A unique value used to identify this patch. For each
interface associated with this patch, the agent reports this
patch index value in the cOPatchIntfPatchId object of the
corresponding cOPatchIntfTable entries.
When the value of this index is equal to the current value
of cOPatchIndexNext, the agent will modify the value of
cOPatchIndexNext to the next unassigned index."::={ cOPatchEntry 1}cOPatchLowIfIndex OBJECT-TYPESYNTAXInterfaceIndexMAX-ACCESSread-createSTATUScurrentDESCRIPTION"The value of this object is equal to MIB II's ifIndex value of
the interface for this patch. The term low implies that this
interface has the numerically lower ifIndex value than the
other interface identified in the same cOPatchEntry.
The value of this object is specified during row creation,
and can never be changed."::={ cOPatchEntry 2}
cOPatchHighIfIndex OBJECT-TYPESYNTAXInterfaceIndexMAX-ACCESSread-createSTATUScurrentDESCRIPTION"The value of this object is equal to MIB II's ifIndex value of
the interface for this patch. The term high implies that this
interface has the numerically higher ifIndex value than the
other interface identified in the same cOPatchEntry.
The value of this object is specified during row creation,
and can never be changed."::={ cOPatchEntry 3}cOPatchType OBJECT-TYPESYNTAXINTEGER{provisioned(1),
automatic(2),other(3)}MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The creation type of the patch. The use is as follows:
provisioned(1)
Provisioned by the user or by a management system
using the Command Line Interface, SNMP, or other
means of management access to the network element.
automatic(2)
Created automatically by the network element, without
user or management intervention. In particular, this
is used to represent fixed patches due to the presence
of entities such as optical backplanes."::={ cOPatchEntry 4}cOPatchStatus OBJECT-TYPESYNTAXINTEGER{noError(1),otherError(2),interfaceError(3),interfaceChannelError(4)}MAX-ACCESSread-onlySTATUScurrent
DESCRIPTION"This object indicates the error status of the patch.
The use is as follows:
noError(1)
This value indicates a patch with no error.
otherError(2)
This value indicates an unknown patch error.
interfaceError(3)
This value indicates one or both interfaces are of
the wrong type for a patch or the two interfaces
are not supposed to be patched together.
interfaceChannelError(4)
This value indicates the frequency channel of the
two interfaces in this patch entry do not match."::={ cOPatchEntry 5}cOPatchCreationTime OBJECT-TYPESYNTAXTimeStampMAX-ACCESSread-only
STATUScurrentDESCRIPTION"The value of MIB II's sysUpTime object at the time this
patch was created. If the current state was
entered prior to the last re-initialization of the agent then
this object contains a zero value."::={ cOPatchEntry 6}cOPatchRowStatus OBJECT-TYPESYNTAXRowStatusMAX-ACCESSread-createSTATUScurrentDESCRIPTION"The status of this entry in the cOPatchTable. This object is
used to create an entry indicating that two interfaces on the
network element have been patched together, or to modify or
delete an existing entry."::={ cOPatchEntry 7}cOPatchDirOnLowIf OBJECT-TYPESYNTAXINTEGER{lowIfDirReceive(1),lowIfDirTransmit(2),lowIfDirBoth(3)}MAX-ACCESSread-createSTATUScurrentDESCRIPTION"In case of an optical interface where the transmitted
and received signals travel on two different strands of
fiber, it is possible that each fiber is patched to a
different interface. This object identifies the patch
direction for this entry relative to the interface with
low ifIndex.
The direction in which the interface with high ifIndex
is patched can be deduced based on this object value.
If the interface with low ifIndex is patched in the
receive direction, the associated high interface has to
be patched in the transmit direction and vice versa. If
the low interface is patched in both directions, the
same should hold true on the interface with high
ifIndex.
"DEFVAL{ lowIfDirBoth }::={ cOPatchEntry 8}cOPatchEventEnabled OBJECT-TYPESYNTAXTruthValue
MAX-ACCESSread-writeSTATUScurrentDESCRIPTION"Notifications that a patch between two interfaces is
created, modified or deleted are enabled if this value
is set to 'true'."DEFVAL{ false }::={ cOPatchMIBObjects 6}-- End of cOPatchTable-- New Patch Interface GroupcOPatchIntfTable OBJECT-TYPESYNTAXSEQUENCEOF COPatchIntfEntry
MAX-ACCESSnot-accessible
STATUScurrentDESCRIPTION"This table lists all interfaces that are provisioned to
indicate that they are patched to other interfaces on the same
network element. The table is used to find patches that
include a particular interface.
An interface can be patched to another interface in the
receive direction, the transmit direction or both
directions. The cOPatchIntfDirection object identifies
the direction."::={ cOPatchMIBObjects 7}cOPatchIntfEntry OBJECT-TYPESYNTAX COPatchIntfEntry
MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"An entry is created only when an interface is provisioned
to indicate that it is patched to another interface on the same
network element (i.e. when the associated entry in the
cOPatchTable has been created).
An entry is deleted when the interface is removed from a patch,
or when the patch is deleted from the cOPatchTable."INDEX{ ifIndex, cOPatchIntfDirection }::={ cOPatchIntfTable 1}
COPatchIntfEntry ::=SEQUENCE{
cOPatchIntfDirection INTEGER,
cOPatchIntfPatchId Integer32}cOPatchIntfDirection OBJECT-TYPESYNTAXINTEGER{ receive(1),transmit(2),both(3)}MAX-ACCESSnot-accessibleSTATUScurrentDESCRIPTION"In case of an optical interface where the transmitted
and received signals travel on two different strands of
fiber, it is possible that each fiber is patched to a
different interface. For example, the transmit and
receive fibers of this interface may have unidirectional
connections to different optical amplifiers.
This object indicates whether this entry describes a
patch in the receive direction, the transmit direction
or both directions. If both the transmit and receive
fibers of this interface are patched to the same
interface, then this object is set to 'both'. Individual
entries for 'transmit' and 'receive' should not be
created in this case."::={ cOPatchIntfEntry 1}cOPatchIntfPatchId OBJECT-TYPESYNTAXInteger32(1..2147483547)MAX-ACCESSread-onlySTATUScurrentDESCRIPTION"The value of cOPatchIndex used in the cOPatchTable to identify
a patch that includes this interface. The other interface
included in that patch has an entry in this table with the same
value of this object, in addition to the entry in the
cOPatchTable with this value of cOPatchIndex."::={ cOPatchIntfEntry 2}-- End of New Patch Interface Group-- NotificationscOPatchMIBNotifications OBJECTIDENTIFIER::={ ciscoOpticalPatchMIB 2}cOPatchEvent NOTIFICATION-TYPEOBJECTS{ cOPatchLowIfIndex,
cOPatchHighIfIndex,
cOPatchType,
cOPatchStatus,
cOPatchEventType }STATUScurrentDESCRIPTION"This notification is generated when ever a patch
is created, modified or deleted."::={ cOPatchMIBNotifications 1}-- End of notifications-- ConformancecOPatchMIBConformance OBJECTIDENTIFIER::={ ciscoOpticalPatchMIB 3}cOPatchMIBCompliances OBJECTIDENTIFIER::={ cOPatchMIBConformance 1}cOPatchMIBGroups OBJECTIDENTIFIER::={ cOPatchMIBConformance 2}
-- CompliancecOPatchMIBCompliance MODULE-COMPLIANCESTATUSdeprecatedDESCRIPTION"The compliance statement for entities which implement
the Cisco Patch MIB"MODULE-- this moduleMANDATORY-GROUPS{ cOPatchInterfaceGroup,
cOPatchGroup,
cOPatchNotifyGroup }::={ cOPatchMIBCompliances 1}
cOPatchMIBCompliance1 MODULE-COMPLIANCESTATUScurrentDESCRIPTION"The compliance statement for entities which implement
the Cisco Patch MIB"MODULE-- this moduleMANDATORY-GROUPS{ cOPatchIntfGroup,
cOPatchGroup1,
cOPatchNotifyGroup }::={ cOPatchMIBCompliances 2}-- Units of ConformancecOPatchInterfaceGroup OBJECT-GROUPOBJECTS{ cOPatchIdentifier
}STATUSdeprecatedDESCRIPTION"Object needed to implement Interfaces with
Patches."::={ cOPatchMIBGroups 1}cOPatchGroup OBJECT-GROUPOBJECTS{ cOPatchIndexNext,
cOPatchLastChange,
cOPatchEventType,
cOPatchEventEnabled,
cOPatchLowIfIndex,
cOPatchHighIfIndex,
cOPatchType,
cOPatchStatus,
cOPatchCreationTime,
cOPatchRowStatus
}STATUSdeprecatedDESCRIPTION"Collection of objects needed to implement
Patches."::={ cOPatchMIBGroups 2}cOPatchNotifyGroup NOTIFICATION-GROUPNOTIFICATIONS{ cOPatchEvent }STATUScurrentDESCRIPTION"Patch error notifications."::={ cOPatchMIBGroups 3}cOPatchIntfGroup OBJECT-GROUP
OBJECTS{ cOPatchIntfPatchId
}STATUScurrentDESCRIPTION"Object needed to implement Interfaces with
Patches."::={ cOPatchMIBGroups 4}cOPatchGroup1 OBJECT-GROUPOBJECTS{ cOPatchIndexNext,
cOPatchLastChange,
cOPatchEventType,
cOPatchEventEnabled,
cOPatchLowIfIndex,
cOPatchHighIfIndex,
cOPatchType,
cOPatchStatus,
cOPatchCreationTime,
cOPatchRowStatus,
cOPatchDirOnLowIf
}STATUScurrentDESCRIPTION"Collection of objects needed to implement
Patches in transmit, receive or both directions."::={ cOPatchMIBGroups 5}-- End of CISCO-PATCH-MIBEND